<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information, see
 * <http://www.doctrine-project.org>.
 */

namespace Doctrine\ORM;

use Doctrine\DBAL\LockMode;

/**
 * An EntityRepository serves as a repository for entities with generic as well as
 * business specific methods for retrieving entities.
 *
 * This class is designed for inheritance and users can subclass this class to
 * write their own repositories with business-specific methods to locate entities.
 *
 * @since   2.0
 * @author  Benjamin Eberlei <kontakt@beberlei.de>
 * @author  Guilherme Blanco <guilhermeblanco@hotmail.com>
 * @author  Jonathan Wage <jonwage@gmail.com>
 * @author  Roman Borschel <roman@code-factory.org>
 */
class EntityRepository {
	/**
	 * @var string
	 */
	protected $_entityName;
	
	/**
	 * @var EntityManager
	 */
	protected $_em;
	
	/**
	 * @var Doctrine\ORM\Mapping\ClassMetadata
	 */
	protected $_class;
	
	/**
	 * Initializes a new <tt>EntityRepository</tt>.
	 *
	 * @param EntityManager $em The EntityManager to use.
	 * @param ClassMetadata $classMetadata The class descriptor.
	 */
	public function __construct($em, Mapping\ClassMetadata $class) {
		$this->_entityName = $class->name;
		$this->_em = $em;
		$this->_class = $class;
	}
	
	/**
	 * Create a new QueryBuilder instance that is prepopulated for this entity name
	 *
	 * @param string $alias
	 * @return QueryBuilder $qb
	 */
	public function createQueryBuilder($alias) {
		return $this->_em->createQueryBuilder()->select( $alias )->from( $this->_entityName, $alias );
	}
	
	/**
	 * Clears the repository, causing all managed entities to become detached.
	 */
	public function clear() {
		$this->_em->clear( $this->_class->rootEntityName );
	}
	
	/**
	 * Finds an entity by its primary key / identifier.
	 *
	 * @param int $id The identifier.
	 * @param int $lockMode 
	 * @param int $lockVersion
	 * @return object The entity.
	 */
	public function find($id, $lockMode = LockMode::NONE, $lockVersion = null) {
		// Check identity map first
		$entity = $this->_em->getUnitOfWork()->tryGetById( $id, $this->_class->rootEntityName );
		if( $entity ) {
			if( !($entity instanceof $this->_class->name) ) {
				return null;
			}
			
			if( $lockMode != LockMode::NONE ) {
				$this->_em->lock( $entity, $lockMode, $lockVersion );
			}
			
			return $entity; // Hit!
		}
		
		if( !is_array( $id ) || count( $id ) <= 1 ) {
			// @todo FIXME: Not correct. Relies on specific order.
			$value = is_array( $id ) ? array_values( $id ) : array( $id );
			$id = array_combine( $this->_class->identifier, $value );
		}
		
		if( $lockMode == LockMode::NONE ) {
			return $this->_em->getUnitOfWork()->getEntityPersister( $this->_entityName )->load( $id );
		} else if( $lockMode == LockMode::OPTIMISTIC ) {
			if( !$this->_class->isVersioned ) {
				throw OptimisticLockException::notVersioned( $this->_entityName );
			}
			$entity = $this->_em->getUnitOfWork()->getEntityPersister( $this->_entityName )->load( $id );
			
			$this->_em->getUnitOfWork()->lock( $entity, $lockMode, $lockVersion );
			
			return $entity;
		} else {
			if( !$this->_em->getConnection()->isTransactionActive() ) {
				throw TransactionRequiredException::transactionRequired();
			}
			
			return $this->_em->getUnitOfWork()->getEntityPersister( $this->_entityName )->load( $id, null, null, array(), $lockMode );
		}
	}
	
	/**
	 * Finds all entities in the repository.
	 *
	 * @return array The entities.
	 */
	public function findAll() {
		return $this->findBy( array() );
	}
	
	/**
	 * Finds entities by a set of criteria.
	 *
	 * @param array $criteria
	 * @return array
	 */
	public function findBy(array $criteria) {
		return $this->_em->getUnitOfWork()->getEntityPersister( $this->_entityName )->loadAll( $criteria );
	}
	
	/**
	 * Finds a single entity by a set of criteria.
	 *
	 * @param array $criteria
	 * @return object
	 */
	public function findOneBy(array $criteria) {
		return $this->_em->getUnitOfWork()->getEntityPersister( $this->_entityName )->load( $criteria );
	}
	
	/**
	 * Adds support for magic finders.
	 *
	 * @return array|object The found entity/entities.
	 * @throws BadMethodCallException  If the method called is an invalid find* method
	 * or no find* method at all and therefore an invalid
	 * method call.
	 */
	public function __call($method, $arguments) {
		if( substr( $method, 0, 6 ) == 'findBy' ) {
			$by = substr( $method, 6, strlen( $method ) );
			$method = 'findBy';
		} else if( substr( $method, 0, 9 ) == 'findOneBy' ) {
			$by = substr( $method, 9, strlen( $method ) );
			$method = 'findOneBy';
		} else {
			throw new \BadMethodCallException( "Undefined method '$method'. The method name must start with " . "either findBy or findOneBy!" );
		}
		
		if( !isset( $arguments[0] ) ) {
			// we dont even want to allow null at this point, because we cannot (yet) transform it into IS NULL.
			throw ORMException::findByRequiresParameter( $method . $by );
		}
		
		$fieldName = lcfirst( \Doctrine\Common\Util\Inflector::classify( $by ) );
		
		if( $this->_class->hasField( $fieldName ) || $this->_class->hasAssociation( $fieldName ) ) {
			return $this->$method( array( $fieldName => $arguments[0] ) );
		} else {
			throw ORMException::invalidFindByCall( $this->_entityName, $fieldName, $method . $by );
		}
	}
	
	/**
	 * @return string
	 */
	protected function getEntityName() {
		return $this->_entityName;
	}
	
	/**
	 * @return EntityManager
	 */
	protected function getEntityManager() {
		return $this->_em;
	}
	
	/**
	 * @return Mapping\ClassMetadata
	 */
	protected function getClassMetadata() {
		return $this->_class;
	}
}